Get saved cards

---

GET /api/distributor/order-id

This GET method allows integrators to retrieve information about a card previously saved in the Keepz system.

Request details

When sending request to Keepz, these four parameters must always be included in the query parameters:

{
  "identifier": "string",
  "encryptedData": "string",
  "encryptedKeys": "string",
  "aes": true
}

identifier

• Unique ID of the integrator in the Keepz system.
• Provided by Keepz during the integration process.

encryptedData

• Contains the actual request payload encrypted using a randomly generated symmetric key and IV (Initialization Vector).

encryptedKeys

• Contains the AES key and IV used to encrypt encryptedData.

aes

• Boolean flag indicating that the request uses AES-based symmetric encryption (needed for backward compatibility with older encryption methods).

For details on the encryption process, see the Encryption Guide documentation.

Parameters

The following parameters form the actual order payload. They must be included inside the encryptedData parameter, which is encrypted and passed in the request as shown above.

Parameter	Type	Required	Description	Possible values	Note
integratorOrderId	string (UUID v4 format)	✅	Unique ID of order in the integrator's system.

Response details

✅ Success Response

If the request is valid, the API returns an encrypted payload:

{
  "encryptedData": "string",
  "encryptedKeys": "string",
  "aes": true
}

encryptedData

• Contains the actual response payload encrypted using a randomly generated symmetric key and IV (Initialization Vector).

encryptedKeys

• Contains the AES key and IV used to encrypt encryptedData.

aes

• Boolean flag indicating that the request uses AES-based symmetric encryption (needed for backward compatibility with older encryption methods).

For details on the decryption process, see the Encryption Guide documentation.

Inside encryptedData, the following parameters are available after decryption:

Field	Type	Possible Values / Format	Description
token	string(UUID v4)		Tokenized card identifier. Can be reused by the integrator for future orders (via cardToken).
provider	string	CREDO	Payment provider that processed the card transaction.
cardMask	string	Masked PAN (e.g., 411111******1111)	Masked card number.
expirationDate	string	Format MM/YY (e.g., 12/27)	Card expiration date.
cardBrand	string	VISA, MasterCard, AMEX, etc.	Brand of the card.

❌ Error Response

If an error occurs, the response is returned without encryption (plain JSON):

{
  "message": "Integrator card not found",
  "statusCode": 6075,
  "exceptionGroup": 5
}

Parameter	Type	Description
message	string	Error message. Details are provided in the dedicated section below.
statusCode	number	Error status code. Details are provided in the dedicated section below.
exceptionGroup	number	Error group. Details are provided in the dedicated section below.

⚠️ Important: Make sure to include the required encryption parameters in your request. The integratorOrderId must be a valid UUID that corresponds to an order where a card was saved.

Details can be found at Error Code Description.